Documentation Powered by Redocly

Axelar - gRPC Gateway docs (1.0.0)

Download OpenAPI specification:Download

A REST interface for state queries, legacy transactions

MsgService

AddCosmosBasedChain

Request Body schema: application/json
sender
string <byte>
object (Chain represents the properties of a registered blockchain)
addr_prefix
string
Array of objects
cosmos_chain
string (TODO: Rename this to `chain` after v1beta1 -> v1 version bump)
ibc_path
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": {
    },
  • "addr_prefix": "string",
  • "native_assets": [
    ],
  • "cosmos_chain": "string",
  • "ibc_path": "string"
}

AxelarnetConfirmDeposit

Request Body schema: application/json
sender
string <byte>
deposit_address
string <byte>
denom
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "deposit_address": "string",
  • "denom": "string"
}

ExecutePendingTransfers

Request Body schema: application/json
sender
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string"
}

RegisterAsset

Request Body schema: application/json
sender
string <byte>
chain
string
object

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "asset": {
    }
}

RegisterFeeCollector

Request Body schema: application/json
sender
string <byte>
fee_collector
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "fee_collector": "string"
}

RetryIBCTransfer

Request Body schema: application/json
sender
string <byte>
chain
string
id
string <uint64>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "id": "string"
}

RouteIBCTransfers

Request Body schema: application/json
sender
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string"
}

AddChain

Request Body schema: application/json
sender
string <byte>
name
string
key_type
string
Default: "KEY_TYPE_UNSPECIFIED"
Enum: "KEY_TYPE_UNSPECIFIED" "KEY_TYPE_NONE" "KEY_TYPE_THRESHOLD" "KEY_TYPE_MULTISIG"
params
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "name": "string",
  • "key_type": "KEY_TYPE_UNSPECIFIED",
  • "params": "string"
}

EvmConfirmDeposit

Request Body schema: application/json
sender
string <byte>
chain
string
tx_id
string <byte>
amount
string <byte>
burner_address
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "tx_id": "string",
  • "amount": "string",
  • "burner_address": "string"
}

ConfirmGatewayTx

Request Body schema: application/json
sender
string <byte>
chain
string
tx_id
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "tx_id": "string"
}

ConfirmToken

Request Body schema: application/json
sender
string <byte>
chain
string
tx_id
string <byte>
object

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "tx_id": "string",
  • "asset": {
    }
}

ConfirmTransferKey

Request Body schema: application/json
sender
string <byte>
chain
string
tx_id
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "tx_id": "string"
}

CreateBurnTokens

Request Body schema: application/json
sender
string <byte>
chain
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string"
}

CreateDeployToken

Request Body schema: application/json
sender
string <byte>
chain
string
object
object
address
string <byte>
daily_mint_limit
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "asset": {
    },
  • "token_details": {
    },
  • "address": "string",
  • "daily_mint_limit": "string"
}

CreatePendingTransfers

Request Body schema: application/json
sender
string <byte>
chain
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string"
}

CreateTransferOperatorship

Request Body schema: application/json
sender
string <byte>
chain
string
key_id
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "key_id": "string"
}

RetryFailedEvent

Request Body schema: application/json
sender
string <byte>
chain
string
event_id
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "event_id": "string"
}

SetGateway

Request Body schema: application/json
sender
string <byte>
chain
string
address
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string",
  • "address": "string"
}

SignCommands

Request Body schema: application/json
sender
string <byte>
chain
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chain": "string"
}

ActivateChain

Request Body schema: application/json
sender
string <byte>
chains
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chains": [
    ]
}

DeactivateChain

Request Body schema: application/json
sender
string <byte>
chains
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chains": [
    ]
}

DeregisterChainMaintainer

Request Body schema: application/json
sender
string <byte>
chains
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chains": [
    ]
}

RegisterAssetFee

Request Body schema: application/json
sender
string <byte>
object

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "fee_info": {
    }
}

RegisterChainMaintainer

Request Body schema: application/json
sender
string <byte>
chains
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "chains": [
    ]
}

DeactivateProxy defines a method for deregistering a proxy account.

Request Body schema: application/json
sender
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string"
}

RegisterProxy defines a method for registering a proxy account that can act in a validator account's stead.

Request Body schema: application/json
sender
string <byte>
proxy_addr
string <byte>

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "proxy_addr": "string"
}

HeartBeat

Request Body schema: application/json
sender
string <byte>
key_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "key_ids": [
    ]
}

QueryService

PendingIBCTransferCount queries the pending ibc transfers for all chains

Responses

BatchedCommands queries the batched commands for a specified chain and BatchedCommandsID if no BatchedCommandsID is specified, then it returns the latest batched commands

path Parameters
chain
required
string
id
required
string

id defines an optional id for the commandsbatch. If not specified the latest will be returned

Responses

BurnerInfo queries the burner info for the specified address

query Parameters
address
string <byte>

Responses

Bytecode queries the bytecode of a specified gateway at the specified chain

path Parameters
chain
required
string
contract
required
string

Responses

Chains queries the available evm chains

Responses

ConfirmationHeight queries the confirmation height for the specified chain

path Parameters
chain
required
string

Responses

ERC20Tokens queries the ERC20 tokens registered for a chain

path Parameters
chain
required
string
query Parameters
type
string
Default: "TOKEN_TYPE_UNSPECIFIED"
Enum: "TOKEN_TYPE_UNSPECIFIED" "TOKEN_TYPE_INTERNAL" "TOKEN_TYPE_EXTERNAL"

Responses

Event queries an event at the specified chain

path Parameters
chain
required
string
event_id
required
string

Responses

GatewayAddress queries the address of axelar gateway at the specified chain

path Parameters
chain
required
string

Responses

KeyAddress queries the address of key of a chain

path Parameters
chain
required
string
query Parameters
key_id
string

Responses

PendingCommands queries the pending commands for the specified chain

path Parameters
chain
required
string

Responses

TokenInfo queries the token info for a registered ERC20 Token

path Parameters
chain
required
string
query Parameters
asset
string
symbol
string

Responses

Assets queries the assets registered for a chain

path Parameters
chain
required
string

Responses

ChainState queries the state of a registered chain on the network

path Parameters
chain
required
string

Responses

Chains queries the chains registered on the network

query Parameters
status
string
Default: "CHAIN_STATUS_UNSPECIFIED"
Enum: "CHAIN_STATUS_UNSPECIFIED" "CHAIN_STATUS_ACTIVATED" "CHAIN_STATUS_DEACTIVATED"

Responses

ChainsByAsset queries the chains that support an asset on the network

path Parameters
asset
required
string

Responses

FeeInfo queries the fee info by chain and asset

query Parameters
chain
string
asset
string

Responses

FeeInfo queries the fee info by chain and asset

path Parameters
chain
required
string
asset
required
string

Responses

LatestDepositAddress queries the a deposit address by recipient

path Parameters
recipient_addr
required
string
recipient_chain
required
string
deposit_chain
required
string

Responses

RecipientAddress queries the recipient address for a given deposit address

path Parameters
deposit_chain
required
string
deposit_addr
required
string

Responses

TransferFee queries the transfer fee by the source, destination chain, and amount. If amount is 0, the min fee is returned

query Parameters
source_chain
string
destination_chain
string
amount
string

Responses

TransferFee queries the transfer fee by the source, destination chain, and amount. If amount is 0, the min fee is returned

path Parameters
source_chain
required
string
destination_chain
required
string
amount
required
string

Responses

TransfersForChain queries transfers by chain

path Parameters
chain
required
string
state
required
string
Enum: "TRANSFER_STATE_UNSPECIFIED" "TRANSFER_STATE_PENDING" "TRANSFER_STATE_ARCHIVED" "TRANSFER_STATE_INSUFFICIENT_AMOUNT"
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Query

Accounts returns all the existing accounts

Since: cosmos-sdk 0.43

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Account returns account details based on address.

path Parameters
address
required
string

address defines the address to query for.

Responses

Params queries all parameters.

Responses

AllBalances queries the balance of all coins for a single account.

path Parameters
address
required
string

address is the address to query balances for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Balance queries the balance of a single coin for a single account.

path Parameters
address
required
string

address is the address to query balances for.

query Parameters
denom
string

denom is the coin denom to query balances for.

Responses

DenomsMetadata queries the client metadata for all registered coin denominations.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DenomsMetadata queries the client metadata of a given coin denomination.

path Parameters
denom
required
string

denom is the coin denom to query the metadata for.

Responses

Params queries the parameters of x/bank module.

Responses

SpendableBalances queries the spenable balance of all coins for a single account.

path Parameters
address
required
string

address is the address to query spendable balances for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

TotalSupply queries the total supply of all coins.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

SupplyOf queries the supply of a single coin.

path Parameters
denom
required
string

denom is the coin denom to query balances for.

Responses

CommunityPool queries the community pool coins.

Responses

DelegationTotalRewards queries the total rewards accrued by a each validator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

DelegationRewards queries the total rewards accrued by a delegation.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

validator_address
required
string

validator_address defines the validator address to query for.

Responses

DelegatorValidators queries the validators of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

DelegatorWithdrawAddress queries withdraw address of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

Params queries params of the distribution module.

Responses

ValidatorCommission queries accumulated commission for a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorOutstandingRewards queries rewards of a validator address.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorSlashes queries slash events of a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

query Parameters
starting_height
string <uint64>

starting_height defines the optional starting height to query the slashes.

ending_height
string <uint64>

starting_height defines the optional ending height to query the slashes.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Allowance returns fee granted to the grantee by the granter.

path Parameters
granter
required
string

granter is the address of the user granting an allowance of their funds.

grantee
required
string

grantee is the address of the user being granted an allowance of another user's funds.

Responses

Allowances returns all the grants for address.

path Parameters
grantee
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AllowancesByGranter returns all the grants given by an address Since v0.46

path Parameters
granter
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AllEvidence queries all evidence.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Evidence queries evidence based on evidence hash.

path Parameters
evidence_hash
required
string <byte>

evidence_hash defines the hash of the requested evidence.

Responses

Params queries all parameters of the gov module.

path Parameters
params_type
required
string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

Responses

Proposals queries all proposals based on given status.

query Parameters
proposal_status
string
Default: "PROPOSAL_STATUS_UNSPECIFIED"
Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED"

proposal_status defines the status of the proposals.

  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
voter
string

voter defines the voter address for the proposals.

depositor
string

depositor defines the deposit addresses from the proposals.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Proposal queries proposal details based on ProposalID.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Deposits queries all deposits of a single proposal.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Deposit queries single deposit information based proposalID, depositAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

depositor
required
string

depositor defines the deposit addresses from the proposals.

Responses

TallyResult queries the tally of a proposal vote.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Votes queries votes of a given proposal.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Vote queries voted information based on proposalID, voterAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

voter
required
string

voter defines the oter address for the proposals.

Responses

AnnualProvisions current minting annual provisions value.

Responses

Inflation returns the current minting inflation value.

Responses

Params returns the total set of minting parameters.

Responses

Params queries a specific parameter of a module, given its subspace and key.

query Parameters
subspace
string

subspace defines the module to query the parameter for.

key
string

key defines the key of the parameter in the subspace.

Responses

Params queries the parameters of slashing module

Responses

SigningInfos queries signing info of all validators

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

SigningInfo queries the signing info of given cons address

path Parameters
cons_address
required
string

cons_address is the address to query signing info of

Responses

DelegatorDelegations queries all delegations of a given delegator address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Redelegations queries redelegations of given address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
src_validator_addr
string

src_validator_addr defines the validator address to redelegate from.

dst_validator_addr
string

dst_validator_addr defines the validator address to redelegate to.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DelegatorValidators queries all validators info for given delegator address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DelegatorValidator queries validator info for given delegator validator pair.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

validator_addr
required
string

validator_addr defines the validator address to query for.

Responses

HistoricalInfo queries the historical info for given height.

path Parameters
height
required
string <int64>

height defines at which height to query the historical info.

Responses

Parameters queries the staking parameters.

Responses

Pool queries the pool info.

Responses

Validators queries all validators that match the given status.

query Parameters
status
string

status enables to query for validators matching a given status.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Validator queries validator info for given validator address.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

Responses

ValidatorDelegations queries delegate info for given validator.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Delegation queries delegate info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

delegator_addr
required
string

delegator_addr defines the delegator address to query for.

Responses

UnbondingDelegation queries unbonding info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

delegator_addr
required
string

delegator_addr defines the delegator address to query for.

Responses

ValidatorUnbondingDelegations queries unbonding delegations of a validator.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AppliedPlan queries a previously applied upgrade plan by its name.

path Parameters
name
required
string

name is the name of the applied plan to query for.

Responses

CurrentPlan queries the current upgrade plan.

Responses

ModuleVersions queries the list of module versions from state.

Since: cosmos-sdk 0.43

query Parameters
module_name
string

module_name is a field to query a specific module consensus version from state. Leaving this empty will fetch the full list of module versions from state.

Responses

UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)

path Parameters
last_height
required
string <int64>

last height of the current chain must be sent in request as this is the height under which next consensus state is stored

Responses

Channels queries all the IBC channels of a chain.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Channel queries an IBC Channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

ChannelClientState queries for the client state for the channel associated with the provided channel identifiers.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

ChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

revision_number
required
string <uint64>

revision number of the consensus state

revision_height
required
string <uint64>

revision height of the consensus state

Responses

NextSequenceReceive returns the next receive sequence for a given channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

PacketAcknowledgements returns all the packet acknowledgements associated with a channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

packet_commitment_sequences
Array of strings <uint64>

list of packet sequences.

Responses

PacketAcknowledgement queries a stored packet acknowledgement hash.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

PacketCommitments returns all the packet commitments hashes associated with a channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

UnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

packet_ack_sequences
required
Array of strings <uint64> non-empty

list of acknowledgement sequences

Responses

UnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

packet_commitment_sequences
required
Array of strings <uint64> non-empty

list of packet sequences

Responses

PacketCommitment queries a stored packet commitment hash.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

PacketReceipt queries if a given packet sequence has been received on the queried chain

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

ConnectionChannels queries all the channels associated with a connection end.

path Parameters
connection
required
string

connection unique identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ClientParams queries all parameters of the ibc client.

Responses

ClientStates queries all the IBC light clients of a chain.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ClientState queries an IBC light client.

path Parameters
client_id
required
string

client state unique identifier

Responses

Status queries the status of an IBC client.

path Parameters
client_id
required
string

client unique identifier

Responses

ConsensusStates queries all the consensus state associated with a given client.

path Parameters
client_id
required
string

client identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ConsensusState queries a consensus state associated with a client state at a given height.

path Parameters
client_id
required
string

client identifier

revision_number
required
string <uint64>

consensus state revision number

revision_height
required
string <uint64>

consensus state revision height

query Parameters
latest_height
boolean <boolean>

latest_height overrrides the height field and queries the latest stored ConsensusState.

Responses

UpgradedClientState queries an Upgraded IBC light client.

Responses

UpgradedConsensusState queries an Upgraded IBC consensus state.

Responses

ClientConnections queries the connection paths associated with a client state.

path Parameters
client_id
required
string

client identifier associated with a connection

Responses

Connections queries all the IBC connections of a chain.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Connection queries an IBC connection end.

path Parameters
connection_id
required
string

connection unique identifier

Responses

ConnectionClientState queries the client state associated with the connection.

path Parameters
connection_id
required
string

connection identifier

Responses

ConnectionConsensusState queries the consensus state associated with the connection.

path Parameters
connection_id
required
string

connection identifier

revision_number
required
string <uint64>
revision_height
required
string <uint64>

Responses

DenomHash queries a denomination hash information.

path Parameters
trace
required
string

The denomination trace ([port_id]/[channel_id])+/[denom]

Responses

DenomTraces queries all denomination traces.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DenomTrace queries a denomination trace information.

path Parameters
hash
required
string

hash (in hex format) of the denomination trace information.

Responses

Params queries all parameters of the ibc-transfer module.

Responses

Service

GetLatestBlock returns the latest block.

Responses

GetBlockByHeight queries block for given height.

path Parameters
height
required
string <int64>

Responses

GetNodeInfo queries the current node info.

Responses

GetSyncing queries node syncing.

Responses

GetLatestValidatorSet queries latest validator-set.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

GetValidatorSetByHeight queries validator-set at a given height.

path Parameters
height
required
string <int64>
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean <boolean>

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean <boolean>

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses